docs: update for pipecat-flows PR #263#765
Open
markbackman wants to merge 1 commit into
Open
Conversation
Updates documentation to reflect type system changes from pipecat-flows PR #263: - Widened function handler return types from FlowResult to Any - Added deprecation notices for FlowResult, ZeroArgFunctionHandler, LegacyFunctionHandler, and LegacyActionHandler - Updated ConsolidatedFunctionResult first element from FlowResult | None to Any - Changed FlowsDirectFunction from Protocol to type alias - Added note about FlowArgs future widening to Mapping[str, Any] in 2.0.0 - Updated examples to use dict/str instead of FlowResult
markbackman
added
auto-docs
|
Preview deployment for your docs. Learn more about Mintlify Previews.
💡 Tip: Enable Workflows to automatically generate PRs for you. |
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
1 participant
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Automated documentation update for pipecat-flows PR #263.
Changes
API Reference
FlowResult | ConsolidatedFunctionResulttoAny. Added deprecation notices forFlowResult,ZeroArgFunctionHandler, andLegacyFunctionHandler. UpdatedConsolidatedFunctionResultfirst element fromFlowResult | NonetoAny. ChangedFlowsDirectFunctiondocumentation to reflect it's now a type alias instead of Protocol. Added note aboutFlowArgsfuture widening toMapping[str, Any]in 2.0.0.register_action().Guides
dict/strreturn types instead ofFlowResult.Gaps identified
None. All changed source files were mapped to their corresponding documentation pages.